home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Helpers / 411Maker 1.0 / Read Me - 411Maker < prev   
Encoding:
Text File  |  1994-11-04  |  3.6 KB  |  39 lines  |  [TEXT/ttxt]

  1. Greetings,
  2.  
  3. The 411Maker application is designed to provide a more pleasant interface for creating and modifying MPW 411 help files.  Here's how it works.
  4.  
  5. The main '411 Maker' dialog provides a set of controls for entering all of the parameters which are normally displayed in an MPW 411 entry.  Clicking on any of the three shadowed boxes in the framed '411 Text' area opens a window which lets you enter up to 32000 characters of text.  Closing the window will display the first 50 or so characters of the text in the shadowed box.
  6.  
  7. Below this framed area are a set of controls which let you specify whether the call moves memory, which set of interfaces it is part of, which actual .a, .p, or .h file it is included in, and any other references to the call in Inside Mac, the Tech Notes, etc.
  8.  
  9. On the right are two lists which let you enter key words which 411 uses to locate entries of interest.  You can add an entry to the list by clicking on the '+' button, typing the entry's text in the text field below the list, and then clicking the '√' button to accept the change.  You can edit an entry by clicking on it, modifying it's text, and then clicking the '√' button.  To delete an item from the list, select it and press the '-' button.  (I know this isn't a standard interface, it's just something I was experimenting with at the time).
  10.  
  11. When you have finished entering the parameters for the 411 Entry, select the "Generate" menu item in the "Transform" menu.  411Maker will open the "Parse/Generate" window and process the parameters you entered to produce something like the following:
  12.  
  13. ----
  14. æKY Dialogs
  15. æFc Dialogs.h
  16. æT FUNCTION
  17. æTN $0xA97D
  18. æD pascal DialogPtr NewDialog(void *wStorage,const Rect *boundsRect,
  19.                                        ConstStr255Param title,
  20.                            Boolean visible,short procID,WindowPtr behind,
  21.                            Boolean goAwayFlag,long refCon, Handle itmLstHndl);
  22. æDT theDialog = NewDialog (dStorage,&wRect,title,visFlag,wDefProcID,
  23.                        behind,goAwayFlag,refCon,itemList);
  24. æMM
  25. æRI I-412
  26. æC 
  27. NewDialog creates a dialog and returns a DialogPtr for use in subsequent Dialog Manager fucntions.  The dialog window is created as with NewWindow.  The GetNewDialog function is used more often since it also sets up the item list.
  28. ----
  29.  
  30. This text can be copied from the "Parse/Generate" window into a file containing many other 411 entries; sorry, the utility doesn't support reading and writing entire files yet.  If there is enough interest, perhaps I will add it in the future.
  31.  
  32. If you want to modify a 411 entry in an existing file, you can copy the text of the item from the file into the "Parse/Generate" window and then choose the "Parse" option in the "Transform" menu.  (As an experiment, you might want to test this with the above text).  411Maker will scan through the text, breaking it down into the appropriate sections and filling in the 411 Maker dialog.  If it encounters an error, it will notify you and the parse will be aborted.  Once you have made the desired changes, simply use "Generate" to generate the new text and copy it back into the original file.
  33.  
  34. NOTE: The "Parse/Generate" window is essentially a scratch window; all of the text which it contains is cleared when a new entry is generated.
  35.  
  36. What else?  Oh yes; Selecting "New" from the "File" menu clears all of the parameters in the dialog so that you can start over from scratch.  Another thing - the "Undo" option is included for completeness, but doesn't currently do anything.  I will add support for it if there is enough interest to warrant the time investment.  Until then, type with care! ;)
  37.  
  38. Eric Rosé
  39. erose@nomos.com